<html>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
<link rel="stylesheet" href="../style.css" type="text/css" media="all" />
<body>
<h1>Field</h1>
<div class="class_description">Объекты этого класса представляют описание полей таблиц в БД, что тождественно равно свойствам/полям типов</div>
<h2>Методы</h2><ul><li><a href="#getAddId">getAddId</a></li><li><a href="#getCharacter">getCharacter</a></li><li><a href="#getConnectionId">getConnectionId</a></li><li><a href="#getErrorMessage">getErrorMessage</a></li><li><a href="#getHelp">getHelp</a></li><li><a href="#getId">getId</a></li><li><a href="#getMaxlength">getMaxlength</a></li><li><a href="#getName">getName</a></li><li><a href="#getPosition">getPosition</a></li><li><a href="#getTitle">getTitle</a></li><li><a href="#getTypeId">getTypeId</a></li><li><a href="#isEditable">isEditable</a></li><li><a href="#isLocked">isLocked</a></li><li><a href="#isReal">isReal</a></li><li><a href="#isRequired">isRequired</a></li><li><a href="#isSearch">isSearch</a></li><li><a href="#__construct">__construct</a></li></ul><a name="getAddId"></a>
<h3>getAddId</h3>
<div class="block description">
<h4>Описание</h4>
<div class="text method_description">
<div class="prototype"><span class="return">integer</span> <span class="name">getAddId</span> ()</div><p>Получить дополнительный id поля</p>
</div>
</div><a name="getCharacter"></a>
<h3>getCharacter</h3>
<div class="block description">
<h4>Описание</h4>
<div class="text method_description">
<div class="prototype"><span class="return">string</span> <span class="name">getCharacter</span> ()</div><p>Получить характер поля (текстовое, числовое, справочник и т.п.)</p>
</div>
</div><a name="getConnectionId"></a>
<h3>getConnectionId</h3>
<div class="block description">
<h4>Описание</h4>
<div class="text method_description">
<div class="prototype"><span class="return">integer</span> <span class="name">getConnectionId</span> ()</div><p>Получить id связи между типами</p>
</div>
</div><a name="getErrorMessage"></a>
<h3>getErrorMessage</h3>
<div class="block description">
<h4>Описание</h4>
<div class="text method_description">
<div class="prototype"><span class="return">string</span> <span class="name">getErrorMessage</span> ()</div><p>Получить текст ошибки поля</p>
</div>
</div><a name="getHelp"></a>
<h3>getHelp</h3>
<div class="block description">
<h4>Описание</h4>
<div class="text method_description">
<div class="prototype"><span class="return">string</span> <span class="name">getHelp</span> ()</div><p>Получить текст подсказки для поля</p>
</div>
</div><a name="getId"></a>
<h3>getId</h3>
<div class="block description">
<h4>Описание</h4>
<div class="text method_description">
<div class="prototype"><span class="return">integer</span> <span class="name">getId</span> ()</div><p>Получить id поля</p>
</div>
</div><a name="getMaxlength"></a>
<h3>getMaxlength</h3>
<div class="block description">
<h4>Описание</h4>
<div class="text method_description">
<div class="prototype"><span class="return">integer</span> <span class="name">getMaxlength</span> ()</div><p>Получить максимально допустимое количество символов</p>
</div>
</div><a name="getName"></a>
<h3>getName</h3>
<div class="block description">
<h4>Описание</h4>
<div class="text method_description">
<div class="prototype"><span class="return">string</span> <span class="name">getName</span> ()</div><p>Получить латинское название поля</p>
</div>
</div><a name="getPosition"></a>
<h3>getPosition</h3>
<div class="block description">
<h4>Описание</h4>
<div class="text method_description">
<div class="prototype"><span class="return">integer</span> <span class="name">getPosition</span> ()</div><p>Получить позицию поля</p>
</div>
</div><a name="getTitle"></a>
<h3>getTitle</h3>
<div class="block description">
<h4>Описание</h4>
<div class="text method_description">
<div class="prototype"><span class="return">string</span> <span class="name">getTitle</span> ()</div><p>Получить название поля</p>
</div>
</div><a name="getTypeId"></a>
<h3>getTypeId</h3>
<div class="block description">
<h4>Описание</h4>
<div class="text method_description">
<div class="prototype"><span class="return">integer</span> <span class="name">getTypeId</span> ()</div><p>Получить id типа, которому принадлежит поле</p>
</div>
</div><a name="isEditable"></a>
<h3>isEditable</h3>
<div class="block description">
<h4>Описание</h4>
<div class="text method_description">
<div class="prototype"><span class="return">boolean</span> <span class="name">isEditable</span> ()</div><p>Узнать, доступно ли поле для редактирования пользователем</p><p><strong>Результат: </strong>true - редактируемо</p>	
</div>
</div><a name="isLocked"></a>
<h3>isLocked</h3>
<div class="block description">
<h4>Описание</h4>
<div class="text method_description">
<div class="prototype"><span class="return">boolean</span> <span class="name">isLocked</span> ()</div><p>Узнать, доступно ли поле на изменение</p><p><strong>Результат: </strong>true - заблокировано</p>	
</div>
</div><a name="isReal"></a>
<h3>isReal</h3>
<div class="block description">
<h4>Описание</h4>
<div class="text method_description">
<div class="prototype"><span class="return">boolean</span> <span class="name">isReal</span> ()</div><p>Проверить, является поле "настоящим" или оно принадлежит другому объекту</p>
</div>
</div><a name="isRequired"></a>
<h3>isRequired</h3>
<div class="block description">
<h4>Описание</h4>
<div class="text method_description">
<div class="prototype"><span class="return">boolean</span> <span class="name">isRequired</span> ()</div><p>Проверить, обязательное поле или нет</p>
</div>
</div><a name="isSearch"></a>
<h3>isSearch</h3>
<div class="block description">
<h4>Описание</h4>
<div class="text method_description">
<div class="prototype"><span class="return">boolean</span> <span class="name">isSearch</span> ()</div><p>Проверить, доступно поле для поиска или нет</p>
</div>
</div><a name="__construct"></a>
<h3>__construct</h3>
<div class="block description">
<h4>Описание</h4>
<div class="text method_description">
<div class="prototype"><span class="return">void</span> <span class="name">__construct</span> (<span class="type">array</span> <span class="varname">$properties</span>)</div><p>Конструктор</p>
</div>
</div></body>
</html>